widget_{$this->id_base}_instance

Filter Hook

Description

Filters the media widget instance prior to rendering the media.

Hook Information

File Location	`wp-includes/widgets/class-wp-widget-media.php` View on GitHub
Hook Type	Filter
Line Number	`255`

Hook Parameters

Type	Name	Description
`array`	`$instance`	Instance data.
`array`	`$args`	Widget args.
`WP_Widget_Media`	`$widget`	Widget object.

Usage Examples

Basic Usage

<?php
// Hook into widget_{$this->id_base}_instance
add_filter('widget_{$this->id_base}_instance', 'my_custom_filter', 10, 3);

function my_custom_filter($instance, $args, $widget) {
    // Your custom filtering logic here
    return $instance;
}

Source Code Context

wp-includes/widgets/class-wp-widget-media.php:255 - How this hook is used in WordPress core

<?php
 250  		 *
 251  		 * @param array           $instance Instance data.
 252  		 * @param array           $args     Widget args.
 253  		 * @param WP_Widget_Media $widget   Widget object.
 254  		 */
 255  		$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );
 256  
 257  		$this->render_media( $instance );
 258  
 259  		echo $args['after_widget'];
 260  	}

PHP Documentation

<?php
/**
		 * Filters the media widget instance prior to rendering the media.
		 *
		 * @since 4.8.0
		 *
		 * @param array           $instance Instance data.
		 * @param array           $args     Widget args.
		 * @param WP_Widget_Media $widget   Widget object.
		 */

Quick Info

Hook Type: Filter
Parameters: 3
File: wp-includes/widgets/class-wp-widget-media.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.